home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / rehash11.zip / REHASH.DOC < prev    next >
Text File  |  1990-10-04  |  4KB  |  117 lines
  1.  
  2.                                  REHASH
  3.                                  v1.10
  4.                                10-04-90
  5.                             by Tom Collins
  6.  
  7.      What
  8.      ----
  9.  
  10.      REHASH is a small RBBS utility for packing and resizing a system's
  11.      users files.  Users can be removed based on the date last on the
  12.      system (or in a conference), and exempted by security level.
  13.  
  14.      Why
  15.      ---
  16.  
  17.      Ideally, you'd set up your BBS with an optimum number of user records
  18.      for both the main board and for conferences.  Determining the optimum
  19.      is at best, an annoying problem.  REHASH takes care of this for you.
  20.      In addition, the users' file "rebuilding" function, normally contained
  21.      within CONFIG, can be done by REHASH from a batch file on a regular
  22.      basis.
  23.  
  24.      Using It
  25.      --------
  26.  
  27.      The generic form of the REHASH command line is:
  28.  
  29.         REHASH <Messages File> <Users File> [/ELx] [/OTy] [/MFz] [/EUm]
  30.  
  31.         The first two parameters are required, and correspond to a set of
  32.         messages/users files.  For example, MESSAGES and USERS, or
  33.         TREKM.DEF and TREKU.DEF.
  34.  
  35.         The /OT parameter tells REHASH to delete users who haven't been on
  36.         (or entered a given conference) in y days.  The default is to not
  37.         delete any users.
  38.  
  39.         The /EL parameter tells REHASH to never delete users whose security
  40.         level is greater than or equal to x.
  41.  
  42.         The /MF parameter forces REHASH to make the users file size at
  43.         least z times the required size.  So, if the users file requires
  44.         space for 100 users, using /MF1.5 causes REHASH to make the file at
  45.         least 150 records.
  46.  
  47.         The /EU parameter tells REHASH to leave room for at least m more
  48.         users than is required.
  49.  
  50.         /EU and /MF can be used together.
  51.  
  52.         If /MF and /EU are omitted, REHASH will leave room for at least 8
  53.         additional users (equivalent to /EU8).
  54.  
  55.      Examples
  56.      --------
  57.  
  58.         a.  REHASH MainM.DEF MainU.DEF /OT60 /EL10
  59.  
  60.             Delete users from the main board who haven't been on in two
  61.             months (and whose security level is less than 10)
  62.  
  63.         b.  REHASH TrekM.DEF TrekU.DEF
  64.  
  65.             Resize the users file to whatever is necessary, and leave
  66.             all user records intact.
  67.  
  68.         c.  REHASH SysopM.DEF SysopU.DEF /EU2
  69.  
  70.             Leave all users intact, and only leave room for two additional
  71.             users.
  72.  
  73.      Notes
  74.      -----
  75.  
  76.      1.  REHASH writes to the CONS: device, so it can be run remotely from
  77.      RBBS on an "exit to DOS" jump.
  78.  
  79.      2.  If RBBS reports insufficient space in a given users file, try
  80.      raising the /EU or /MF values.
  81.  
  82.      3.  The '/' parameters can be in any order, but the messages and users
  83.      file names have to be the first two parameters.
  84.  
  85.      Source Code
  86.      -----------
  87.  
  88.      The source code, written in MicroSoft QuickBASIC, is included.
  89.  
  90.      Errors
  91.      ------
  92.  
  93.      REHASH first reads the specified users file, and figures out the
  94.      number of records it thinks will be required to resize your file.  It
  95.      then tries resizing with that number.  If it can't fit all of the
  96.      users into that size users file, it tries the next higher size.  So,
  97.      if you see that it "fails" at resizing, don't worry.  It'll just go on
  98.      and try again (up to a limit, of course).
  99.  
  100.      Bugs
  101.      ----
  102.  
  103.      If you run into bugs, please point them out to me.  I can be reached
  104.      at the MSFA BBS, FidoNet 1:261/1047, 1-301-536-1935.
  105.  
  106.      Guarantees
  107.      ----------
  108.  
  109.      If you always back up your RBBS system files before using REHASH,
  110.      you'll never lose data...
  111.  
  112.  
  113.      Good luck!
  114.  
  115.      -- Tom Collins
  116.  
  117.